Update model inspector documentation - #24
Merged
crowbat merged 1 commit intoJul 10, 2026
Merged
Conversation
crowbat
commented
Jul 1, 2026
crowbat
commented
Contributor
- Minor updates to eager mode model inspector
crowbat
force-pushed
the
u/k_hsieh/update_model_inspector_docs_and_minor_updates
branch
from
July 1, 2026 20:05
7bc9c01 to
6008c27
Compare
u-simha
reviewed
Jul 1, 2026
u-simha
left a comment
u-simha
left a comment
Contributor
There was a problem hiding this comment.
Could you provide a doc preview? Would make it much easier to look at the flow and review
|
|
||
| - **Graph mode** (`execution_mode="graph"`): Exports the model with `torch.export` and walks the resulting FX graph. Op names are global identifiers assigned during export (for example, `"linear"`, `"linear_1"`). The compressor must be `Quantizer` or `None`. | ||
| - **Eager mode** (`execution_mode="eager"`): Intercepts operations during a live forward pass. Op names are module-qualified identifiers that reflect the module hierarchy (for example, `"linear1.linear"`, `"linear2.linear"`). This mode supports both `Quantizer` and `KMeansPalettizer` as the compressor. | ||
|
|
Contributor
There was a problem hiding this comment.
We should link to the section that explains the differences between Graph & Eager here
| Note the use of `compressor=Quantizer` in the list of arguments to `ModelInspector`. This filters the list of ops captured and displayed by `ModelInspector` to only those operations which are registered for compressibility by `Quantizer`. Omitting this argument allows for all ops to be captured and displayed. | ||
| Pass `colorize=False` to suppress ANSI color codes, for example when writing to a file. | ||
|
|
||
| Note the use of `compressor=Quantizer`. This filters the captured and displayed ops to those registered as compressible by `Quantizer`. Omit this argument to capture and display all ops. |
Contributor
There was a problem hiding this comment.
Would suggest using the
:::{note}
to call out this section
crowbat
force-pushed
the
u/k_hsieh/update_model_inspector_docs_and_minor_updates
branch
from
July 6, 2026 17:45
6008c27 to
8dc9c47
Compare
u-simha
approved these changes
Jul 10, 2026
- Minor updates to eager mode model inspector
crowbat
force-pushed
the
u/k_hsieh/update_model_inspector_docs_and_minor_updates
branch
from
July 10, 2026 01:18
8dc9c47 to
886d7e0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.